Schemat bigApi.v1
Typ złożony ResponseMessage
Schemat bigApi.v1 : Typ złożony ResponseMessage
Opis
Odpowiedź
Typ reprezentujący rezultat przetworzenia wywołanej operacji BIG API.
Response message
Type representing the result of the processed BIG API call.
Przestrzeń nazw http://api.big.pl/bigApi/v1/types
Diagram
Element data Element customProtocol Element protocol Choice Element user Element requestDateTime Element requestId Element responseDateTime Element responseId Sequence Typ złożony ResponseMessage
Overview
ResponseMessage
Odpowiedź
Typ reprezentujący rezultat przetworzenia wywołanej operacji BIG API.
Response message
Type representing the result of the processed BIG API call.
Sequence
responseId Typ prosty messageId
Identyfikator odpowiedzi
Ciąg znaków jednoznacznie identyfikujący odpowiedź z systemu SIBIG. Nadawany przez BIG IM.
Response id
String uniquely identifying the response. Given by the BIG IM.
responseDateTime xs:dateTime
Data i czas przesłania odpowiedzi
Response date and time
requestId Typ prosty messageId
Identyfikator żądania
Ciąg znaków identyfikujący komunikat żądania, z którym związana jest ta odpowiedź. Nadawany przez system subskrybenta, powinien jednoznacznie identyfikować żądanie w zbiorze żądań przekazanych przez subskrybenta.
Request id
String uniquely identifying the request. Given by the subscriber.
requestDateTime xs:dateTime
Data i czas przesłania żądania
Request date and time
user xs:string
Identyfikator użytkownika
Identyfikator użytkownika przesyłającego żądanie w rejestrze BIG IM.
Username
ID of the SIBIG user submitting the request.
Choice
protocol Typ prosty protocolEnum
Protokół
Wskazanie wybranego protokołu wymiany danych z użyciem BIG API. Przekazywane w ramach żądania dane muszą być zgodne z wybranym protokołem. Protokoły są wyspecyfikowane w osobnych schematach i dokumentacjach.
Protocol
Indication of the selected data exchange protocol to use with BIG API.
customProtocol xs:string
Dedykowany protokół
Wskazanie innego protokołu wymiany danych z użyciem BIG API. Protokół spoza standardowej listy może być użyty w uzgodnieniu z BIG InfoMonitor.
Custom protocol
Indication of the custom data exchange protocol to use with BIG API. Custom protocol can be indicated only in agreement with BIG IM.
data xs:string
Dane odpowiedzi
Dane przesyłane w ramach odpowiedzi z SIBIG. Są zgodne ze specyfikacją wskazanego protokołu (@ResponseMessage/protocol).
Response data
Data submitted as a response of SIBIG. They conform to the specification of the selected protocol (@RequestMessage/protocol).
Używany przez
Element updateEconomicInformationResponse
Element getReportResponse
Element updateLiabilityResponse
Element getStatisticResponse
Element checkAppStatusResponse
Element updateMonitoringResponse
Element removeTracedEventsResponse
Element getMonitoredEntitiesResponse
Element getTracedEventsResponse
Element whoMonitorsMeResponse
Element addOrderResponse
Element getOrderListResponse
Element getOrderStatusResponse
Źródło
<xs:complexType name="ResponseMessage" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Odpowiedź</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Typ reprezentujący rezultat przetworzenia wywołanej operacji BIG API.</div>
      <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Response message</div>
      <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Type representing the result of the processed BIG API call.</div>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="responseId" type="ba:messageId">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Identyfikator odpowiedzi</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Ciąg znaków jednoznacznie identyfikujący odpowiedź z systemu SIBIG. Nadawany przez BIG IM.</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Response id</div>
          <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">String uniquely identifying the response. Given by the BIG IM.</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="responseDateTime" type="xs:dateTime">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Data i czas przesłania odpowiedzi</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Response date and time</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="requestId" type="ba:messageId">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Identyfikator żądania</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Ciąg znaków identyfikujący komunikat żądania, z którym związana jest ta odpowiedź. Nadawany przez system subskrybenta, powinien jednoznacznie identyfikować żądanie w zbiorze żądań przekazanych przez subskrybenta.</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Request id</div>
          <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">String uniquely identifying the request. Given by the subscriber.</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="requestDateTime" type="xs:dateTime">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Data i czas przesłania żądania</div>
          <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Request date and time</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="user" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Identyfikator użytkownika</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Identyfikator użytkownika przesyłającego żądanie w rejestrze BIG IM.</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Username</div>
          <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">ID of the SIBIG user submitting the request.</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:choice>
      <xs:element name="protocol" type="ba:protocolEnum">
        <xs:annotation>
          <xs:documentation>
            <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Protokół</div>
            <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Wskazanie wybranego protokołu wymiany danych z użyciem BIG API. Przekazywane w ramach żądania dane muszą być zgodne z wybranym protokołem. Protokoły są wyspecyfikowane w osobnych schematach i dokumentacjach.</div>
            <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Protocol</div>
            <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Indication of the selected data exchange protocol to use with BIG API.</div>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="customProtocol" type="xs:string">
        <xs:annotation>
          <xs:documentation>
            <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Dedykowany protokół</div>
            <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Wskazanie innego protokołu wymiany danych z użyciem BIG API. Protokół spoza standardowej listy może być użyty w uzgodnieniu z BIG InfoMonitor.</div>
            <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Custom protocol</div>
            <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Indication of the custom data exchange protocol to use with BIG API. Custom protocol can be indicated only in agreement with BIG IM.</div>
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:choice>
    <xs:element name="data" type="xs:string">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Dane odpowiedzi</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Dane przesyłane w ramach odpowiedzi z SIBIG. Są zgodne ze specyfikacją wskazanego protokołu (@ResponseMessage/protocol).</div>
          <div class="nazwa en-GB" xmlns="http://www.w3.org/1999/xhtml">Response data</div>
          <div class="opis en-GB" xmlns="http://www.w3.org/1999/xhtml">Data submitted as a response of SIBIG. They conform to the specification of the selected protocol (@RequestMessage/protocol).</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>
Zobacz także
Schemat bigApi.v1

 

 

© 2021 BIG InfoMonitor S.A. Wszystkie prawa zastrzeżone.

Prześlij komentarz lub zapytanie.